home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_5 / pdbank14.lha / PDBank.doc < prev    next >
Text File  |  1994-11-25  |  8KB  |  236 lines
  1. -----------------------------------------------------------------------------
  2.  
  3.                        The Metro TimeBank System
  4.  
  5.                   Copyright (c) 1991-94 by Peter Deane
  6.  
  7.                               Version 1.4
  8.  
  9.                                25-Nov-94
  10.  
  11. -----------------------------------------------------------------------------
  12.  
  13.  
  14.  
  15. Intro:
  16. ~~~~~~
  17.  
  18. This is OzMetro's first Time-Bank Door.
  19.  
  20. To  get this door to run you should copy the file 'Door.exe' to whatever
  21. into  its  own  door directory in accordance with the OzMetro Docs.  And
  22. don't forget to then edit the doorcmdsX file so the users can access it!
  23.  
  24.  
  25. Files Required:
  26. ~~~~~~~~~~~~~~~
  27.  
  28. The  door  is  in  GFA Basic, and requires no other files apart from the
  29. config  and  the help file.  It will create a file called 'accounts' the
  30. first  time it is run which contains all the data for the users who open
  31. accounts.  This file will grow in size as more and more users join up.
  32.  
  33. If  a  user  gets  time  transfered  to  their  account,  a  file called
  34. 'USERNAME.msg'  will  be created in the door directory which is simply a
  35. message  to  the  user that someone's given them extra time.  As soon as
  36. that user enters the bank, the message will be printed and deleted.
  37.  
  38.  
  39. PDBank.config:
  40. ~~~~~~~~~~~~~~
  41.  
  42. Before  running  the  door you also need to edit the configuration.  The
  43. config file must be in the same directory as the door.
  44.  
  45. Here's the config I'm using:
  46.  
  47.  
  48. The Bank of Inquestor        <-- Name of the bank
  49. 30                           <-- Maximum Daily Deposits
  50. 60                           <-- Maximum Daily Withdrawals
  51. 100                          <-- Maximum Daily Transfers
  52.  
  53.  
  54. (After  the  first  four  lines  you may have any number of extra lines,
  55. which will all be ignored).
  56.  
  57. The  first  line  (name  of the bank) should be less than 24 characters.
  58. (If  it's  longer,  that's  fine  - but it just doesn't look nice on the
  59. menu).   (Oh,  and  it  prints  up like:  'Bank limits for:  The Bank of
  60. Inquestor'.   What you actually put there is up to you, but make sure it
  61. makes sense!)
  62.  
  63. Note  that the limits you set affect users cumulatively for each 24 hour
  64. period.   The  door  remembers exactly how much the user has transacted,
  65. and  will  keep  remembering  it if the user re-enters the door later in
  66. that  day.   If  they visit on the next day, naturally, the transactions
  67. will be re-set to zero.
  68.  
  69.  
  70. Banned Users:
  71. ~~~~~~~~~~~~~
  72.  
  73. New  in  version  1.1  is  a  'banned  users'  file.  This is completely
  74. optional  -  you  don't actually NEED it.  However, if a user is abusing
  75. the  door (and the [T]ransfer Time function will permit some 'foul play'
  76. to go on), you may like to BAN them from it completely.
  77.  
  78. You simply make a file in the door directory called 'PDBank.banned'.  In
  79. it,  simply  enter the name(s) of banned users, one each line.  A sample
  80. file is included in the archive.  Add YOUR name to it if you want to see
  81. how  it  works.   Use  any old text editor to create this file.  You can
  82. even  use  Metro's  editor  (from Sysop Maintenance) to do this.  If you
  83. know  the  pathname to your Time Bank door, you could even add this file
  84. from remote!
  85.  
  86. Be aware of the constraints of GFA-BASIC and 'End-Of-File'.  You need to
  87. have  a  blank  carriage return at the end.  In any case, I think you'll
  88. know  what  I  mean.   Because  of its nature, you can have two or three
  89. carriage returns at the end if you want to be on the safe side, here.
  90.  
  91. A possible PDBank.banned file might look like:
  92.  
  93.  
  94. FRED SMITH
  95. Ronald Reagan
  96. PETER DEANE
  97. Percy Broadnax
  98. harry bloGGS
  99. MIKHAEL GORBACHEV
  100.  
  101.  
  102. It  does  not  matter  what  case you use for the banned users file, the
  103. comparison is converted to all uppercase when read in.
  104.  
  105. A dialogue with a banned user goes a little like:
  106.  
  107. Welcome  to  the  Time Bank (version and author details).  Checking your
  108. account...   (slight  pause).  You have been BANNED from the use of this
  109. door!  Contact your sysop for further details.  [Any_Key].
  110.  
  111. Then  the standard 'Goodbye' routine is output, and they are tossed back
  112. to the doorhandler.
  113.  
  114.  
  115. Maintenance:
  116. ~~~~~~~~~~~~
  117.  
  118. At  any time a level 9 user (ie SYSOP) is in the door, there is an extra
  119. hidden option not printed on the menus.  Press 'M' for maintenance.
  120.  
  121. I'll repeat that in case you missed it, as it's not overly apparent.  To
  122. access  the  sysop  maintenance  section, press 'M' from the bank's main
  123. menu.   You  will only be able to use the maintenance section if you are
  124. level  9  security,  but IT'S THERE!  Don't miss it, because it's NOT on
  125. the menu.
  126.  
  127. Maintenance  allows  you to edit an individual user's records, delete an
  128. account, or add an account for any user you wish.  It also has the 'List
  129. Accounts' function duplicated for added convenience.
  130.  
  131. When  you  add  a  user,  the account is set up with zero balances, etc.
  132. After they have been added, you may then like to [E]dit their account if
  133. you want to give them time, or if you realise you've typo'ed the name or
  134. something.
  135.  
  136. I probably don't have to go into much detail on the maintenance section,
  137. as  I  reckon  it's  self-explanatory.  Just note that the parameters to
  138. edit are hot-keyed, so don't press return until after you've entered the
  139. change.
  140.  
  141. NB:   If  using  this  function  to  edit  your  OWN  account,  you MUST
  142. immediately  quit  the  door  after  saving  the  changes.  You can then
  143. re-enter the door.
  144.  
  145. NB:   You  cannot  delete YOURSELF from the bank.  Ever.  Don't even try
  146. it.   The sysop gets an account the first time the door is run, and must
  147. always  have an account.  Anyone who actually uses the bank MUST have an
  148. account  there,  and  if  you delete yourself while in the bank, it will
  149. become extremely confused.
  150.  
  151. If  you  DO  wish to delete your own account, setup another account from
  152. Metro with level 9 security.  You can use that name to delete your name.
  153. However,  if  you  wish  to delete THAT name, you'll have to use another
  154. username,  in  the  same way, as they'll get an account.  If you wish to
  155. delete   THAT  user,  you'll  have  to  use  yet  another  name...   (ad
  156. infinitum).   Just accept it that the sysop has account number 1, and it
  157. should stay that way!
  158.  
  159.  
  160. Sample setup:
  161. ~~~~~~~~~~~~~
  162.  
  163. BBS:DOORFILES1/DOOR211/
  164.  
  165.   Door.exe
  166.   PDBank.config
  167.   PDBank.help
  168.   PDBank.banned
  169.  
  170. Simple,  eh?  This door has been designed to be ultra-user-friendly.  As
  171. a  suggestion,  I  always also keep the docs and source for each door in
  172. that  door  directory.  If you copy the archive into your door directory
  173. and extract it into that directory, you'll find this a convenient way of
  174. doing  things.   But  if  you're  reading  these  docs, you've obviously
  175. extracted the archive already.  Ah well, next door!
  176.  
  177.  
  178. Notes:
  179. ~~~~~~
  180.  
  181. If  you need further information on the operation of the door, check out
  182. the  file  PDBank.help.   You  can do this with whatever you're using to
  183. read  this, or from within the bank itself.  Feel free to edit this file
  184. if  you wish to customise it, etc...  (and you've got the time).  I have
  185. kept  it  to  40  columns,  since  the Time Bank itself only requires 40
  186. columns.   So  far  I  have  only  one user who's stuck with a 40 column
  187. format, but, well...
  188.  
  189. To  take  full  advantage  of the door, you should use the FF program on
  190. your  workbench  to set your default workbench font to an ibm font.  The
  191. menus heavily rely on the IBM font, and look a bit weird in Topaz.
  192.  
  193.  
  194. Copyrights, etc:
  195. ~~~~~~~~~~~~~~~~
  196.  
  197. I  accept no responsibility for ANY damages that may occur while running
  198. this door.
  199.  
  200. The  TimeBank  System  is  copyright  by  Peter  F  Deane.  It is freely
  201. distributable providing no profit is made from its distribution.  If any
  202. money  is  made  from distributing it, the proceeds must be forwarded to
  203. me.
  204.  
  205.  
  206. Contact:
  207. ~~~~~~~~
  208.  
  209. Postal:
  210.  
  211. Peter Deane
  212. PO Box 228
  213. Swansea  NSW  2281
  214. AUSTRALIA
  215.  
  216. Call Inquestor BBS 24 Hours:
  217.  
  218. 011-61-49-72-1647 from the USA
  219. (049) 72-1647 from within Australia
  220.  
  221.  
  222.  
  223. Source:
  224. ~~~~~~~
  225.  
  226. The full GFA source code is included in ASCII format for you to look and
  227. learn.  If you make any changes to the source, you MUST leave my name in
  228. as author.
  229.  
  230.  
  231.    Have Fun
  232.  - Peter Deane
  233.  
  234. -----------------------------------------------------------------------------
  235.  
  236.